docs: add a note for useHydrateAtoms client code usage #2761
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
|
| Playground | Link |
|---|---|
| React demo | https://livecodes.io?x=id/936GD3RB3 |
See documentations for usage instructions.
dai-shi
approved these changes
Oct 4, 2024
alexandresoro
pushed a commit
to alexandresoro/ouca
that referenced
this pull request
Dec 23, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [jotai](https://github.com/pmndrs/jotai) | dependencies | minor | [`2.9.3` -> `2.11.0`](https://renovatebot.com/diffs/npm/jotai/2.9.3/2.11.0) | --- ### Release Notes <details> <summary>pmndrs/jotai (jotai)</summary> ### [`v2.11.0`](https://github.com/pmndrs/jotai/releases/tag/v2.11.0) [Compare Source](pmndrs/jotai@v2.10.4...v2.11.0) There are no public API changes, but some internal behaviors have been improved. Now, atom updates are batched in a single write, which might provide a performance benefit in certain edge cases. This feature has been requested actually for a long time, and it's finally implemented. See also [#​2782](pmndrs/jotai#2782). #### What's Changed - refactor(store): rename pending to batch by [@​dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2868 - lazy recomputeDependents by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2827 - fix(store): robust flush batch by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2871 - fix(store): refactor batch priority by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2875 - feat: dev store with unstable_derive by [@​dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2852 #### New Contributors - [@​rainagalbiati-turngate](https://github.com/rainagalbiati-turngate) made their first contribution in pmndrs/jotai#2882 - [@​leweyse](https://github.com/leweyse) made their first contribution in pmndrs/jotai#2883 **Full Changelog**: pmndrs/jotai@v2.10.4...v2.11.0 ### [`v2.10.4`](https://github.com/pmndrs/jotai/releases/tag/v2.10.4) [Compare Source](pmndrs/jotai@v2.10.3...v2.10.4) A minor improvement for some edge cases. (For more information, see [#​2789](pmndrs/jotai#2789).) #### What's Changed - fix(store): do not recompute unmounted atoms eagerly by [@​dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2849 #### New Contributors - [@​rmillio](https://github.com/rmillio) made their first contribution in pmndrs/jotai#2832 - [@​sukvvon](https://github.com/sukvvon) made their first contribution in pmndrs/jotai#2851 **Full Changelog**: pmndrs/jotai@v2.10.3...v2.10.4 ### [`v2.10.3`](https://github.com/pmndrs/jotai/releases/tag/v2.10.3) [Compare Source](pmndrs/jotai@v2.10.2...v2.10.3) This fixes various edge cases. Huge thanks to [@​dmaskasky](https://github.com/dmaskasky) ! 🎉 #### What's Changed - fix: flushPending in async write by [@​dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2804 - fix: flush pending finally everywhere by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2818 - fix: rethrow falsy errors thrown in flushPending by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2820 - fix: setAtom uses stale pending on atom unmount by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2811 - fix: onMount setSelf does not notify listeners by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2815 - refactor(core): Use iterative approach in recompute dependents by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2821 - refactor(store): prefer epoch number comparisons to indicate value change by [@​dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2828 **Full Changelog**: pmndrs/jotai@v2.10.2...v2.10.3 ### [`v2.10.2`](https://github.com/pmndrs/jotai/releases/tag/v2.10.2) [Compare Source](pmndrs/jotai@v2.10.1...v2.10.2) Fixed some jotai/utils for a regression in v2.10.0. #### What's Changed - fix(unstable_derive): trap atom methods by [@​dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2741 - Throw error on `useAtom(undefined)` or `useAtom(null)` by [@​kevinschaich](https://github.com/kevinschaich) in pmndrs/jotai#2778 - fix(utils): make 'loadable' update immediate after resolve by [@​e7h4n](https://github.com/e7h4n) in pmndrs/jotai#2790 - fix(utils): make 'unwrap' update immediate after resolve by [@​organize](https://github.com/organize) in pmndrs/jotai#2794 #### New Contributors - [@​niklasbec](https://github.com/niklasbec) made their first contribution in pmndrs/jotai#2773 - [@​romain-trotard](https://github.com/romain-trotard) made their first contribution in pmndrs/jotai#2781 - [@​kretajak](https://github.com/kretajak) made their first contribution in pmndrs/jotai#2786 - [@​Brokyeom](https://github.com/Brokyeom) made their first contribution in pmndrs/jotai#2798 - [@​ryoku4](https://github.com/ryoku4) made their first contribution in pmndrs/jotai#2802 - [@​yairEO](https://github.com/yairEO) made their first contribution in pmndrs/jotai#2805 - [@​kevinschaich](https://github.com/kevinschaich) made their first contribution in pmndrs/jotai#2778 - [@​e7h4n](https://github.com/e7h4n) made their first contribution in pmndrs/jotai#2790 - [@​organize](https://github.com/organize) made their first contribution in pmndrs/jotai#2794 **Full Changelog**: pmndrs/jotai@v2.10.1...v2.10.2 ### [`v2.10.1`](https://github.com/pmndrs/jotai/releases/tag/v2.10.1) [Compare Source](pmndrs/jotai@v2.10.0...v2.10.1) This fixes a bug in an extreme edge case. If you find this change breaks something, please report to us. #### What's Changed - fix(core): recompute dependents in edge cases by [@​dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2742 #### New Contributors - [@​vangie](https://github.com/vangie) made their first contribution in pmndrs/jotai#2753 - [@​ts1994tw](https://github.com/ts1994tw) made their first contribution in pmndrs/jotai#2759 - [@​KagamiChan](https://github.com/KagamiChan) made their first contribution in pmndrs/jotai#2761 - [@​nguyenbry](https://github.com/nguyenbry) made their first contribution in pmndrs/jotai#2762 - [@​jaycho46](https://github.com/jaycho46) made their first contribution in pmndrs/jotai#2766 - [@​midzdotdev](https://github.com/midzdotdev) made their first contribution in pmndrs/jotai#2767 **Full Changelog**: pmndrs/jotai@v2.10.0...v2.10.1 ### [`v2.10.0`](https://github.com/pmndrs/jotai/releases/tag/v2.10.0) [Compare Source](pmndrs/jotai@v2.9.3...v2.10.0) It comes with another significant internal change to address some edge cases. Since v2.9.0, we've been working on some internal refactors to support more edge cases and clean up the code. Users are encouraged to update to the new versions eventually, but if you're satisfied with the current situation and prefer to avoid temporary instability, you can stick with v2.8.4 for now. #### What's Changed - breaking(core): avoid continuable promise in store api by [@​dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2695 #### New Contributors - [@​sphinxrave](https://github.com/sphinxrave) made their first contribution in pmndrs/jotai#2653 - [@​mxthxngx](https://github.com/mxthxngx) made their first contribution in pmndrs/jotai#2712 - [@​hoangvu12](https://github.com/hoangvu12) made their first contribution in pmndrs/jotai#2716 - [@​YuHyeonWook](https://github.com/YuHyeonWook) made their first contribution in pmndrs/jotai#2734 **Full Changelog**: pmndrs/jotai@v2.9.3...v2.10.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS41Ny40IiwidXBkYXRlZEluVmVyIjoiMzkuODIuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19--> Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/380 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Bug Reports or Discussions
Fixes #2470#discussioncomment-10838165
Summary
This PR adds a note for
useHydrateAtomsdocs to emphasize its client code usage.Preview:
Check List
pnpm run prettierfor formatting code and docs